# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Sneak King Template

game: Sneak King
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.
  game:
    Sneak King: 0.1.0 # Version of the world required for this yaml to work as expected.

Sneak King:
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  goal:
    # The win condition for the game.
    # Complete X Missions: complete the required number of missions at any rank.
    # Complete X A-Ranks: earn A-rank on the required number of missions.
    complete_x_missions: 50
    complete_x_a_ranks: 0

  goal_range:
    # The number of missions or A-ranks required to complete the goal.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 10
    # Maximum value is 80
    40: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-10-80: 0 # random value between 10 and 80

  starting_level:
    # The level you start with access to. All other levels must be unlocked.
    sawmill: 50
    cul_de_sac: 0
    construction: 0
    downtown: 0

  enabled_ranks:
    # Which rank tiers count as locations. Disabling a rank removes those checks from the pool.
    ['C', 'B', 'A']

  level_unlock_method:
    # How non-starting levels are unlocked.
    # Unlock Item: each level requires a specific unlock item from the item pool.
    # X Missions: each level unlocks after completing a set number of missions in the previous level.
    x_missions: 0
    unlock_item: 50

  level_unlock_range:
    # When using the X Missions unlock method, the number of missions that must be completed
    # in a level before the next level in the chain becomes accessible.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 5
    # Maximum value is 20
    10: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-5-20: 0 # random value between 5 and 20

  level_shuffle:
    # Randomize the order in which levels appear in the unlock chain.
    # When disabled, the unlock order is Sawmill -> Cul-De-Sac -> Construction -> Downtown.
    # Only has an effect if the Level Unlock Method is set to X Missions.
    'false': 0
    'true': 50

  king_speed_multiplier:
    # Multiplier applied to the King's movement speed.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 2
    1: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-2: 0 # random value between 1 and 2

  civilian_speed_multiplier:
    # Multiplier applied to civilian movement speed.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 2
    1: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-2: 0 # random value between 1 and 2

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
